home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / diag / itcom1.zip / COMPARE.EXE / IT / COMPARES.TXT < prev    next >
Text File  |  1993-10-29  |  19KB  |  459 lines
  1. <<Introduction>>
  2. IT Compares Introduction
  3. ════════════════════════
  4.  
  5.          IT Compares is one of many modules in the ITs for Clarion
  6.          series of utilties.  IT Compares has been created at the
  7.          request of Clarion Professional Developer (CPD) developers
  8.          and at the interest of Clarion Database Developer (CDD)
  9.          developers.
  10.  
  11.          IT Compares' purpose is to support developers in maintaining
  12.          common file structures across applications and help
  13.          identify any differences.  Developers of applications using
  14.          Clarion Professional Developer (CPD) must maintain the file
  15.          structures in each individual APP files. For systems where
  16.          multiple EXEs are implemented on a similar set of files,
  17.          this can become an increasingly difficult task as the
  18.          number of EXEs increases.
  19.  
  20.          Since CPD does not support a central data dictionary, the
  21.          developer must either IMPORT file definitions from a master
  22.          APP (administratively controlled) or maintain the file
  23.          definitions through hand coding with or without the use
  24.          of INCLUDEs.
  25.  
  26.          The majority of us have invested in the Clarion development
  27.          environment in an effort to increase our productivity; and
  28.          therefore, minimize the amount of hand coding and the amount
  29.          of required maintenance.
  30.  
  31.          IT Compares prompts for the selection of two Clarion source
  32.          files.  Each is validated as a Clarion PROGRAM file.  Once
  33.          the files have been selected, the data declaration sections
  34.          are text parsed into an internal data structure.  Three reports
  35.          are available on the internal data.
  36.  
  37.                     Report on the differences in files, keys,
  38.                      indices, fields, groups, and memos on
  39.                      file labels common to both files.
  40.  
  41.                     Report on file components identified in the
  42.                      first file selected not present in the second
  43.                      file selected.
  44.  
  45.                     Report on file components identified in the
  46.                      second file selected not present in the first
  47.                      file selected.
  48.  
  49. <<IT Compares Does and Does NOT>>
  50. <IT Compares Does>
  51.     IT Compares Does
  52.     ────────────────
  53.  
  54.                     Support FILE definitions in the GLOBAL scope.
  55.  
  56.                     Support FILE definitions in INCLUDEd files
  57.                      called within the GLOBAL scope.
  58.  
  59. <IT Compares Does Not>
  60.     IT Compares Does Not
  61.     ────────────────────
  62.  
  63.                     Support FILE definitions outside of the GLOBAL
  64.                      scope.  FILE definitions declared in the LOCAL
  65.                      STATIC scope are not identified.  This feature
  66.                      is tagged for a future version release.
  67.  
  68.                     As of Clarion Database Developer batch release
  69.                      3005, the EXTERNAL attribute use on a
  70.                      file declaration is NOT supported in the current
  71.                      release of IT Compares.  This deficiency is due
  72.                      to the timing of the 3005 batch release and this
  73.                      release of IT Compares.  This feature is tagged
  74.                      for a future version release.
  75.  
  76.                     Search the PATH nor use the redirect (RED) file
  77.                      for locating any files within the original
  78.                      source files.  This feature is tagged for a future
  79.                      version release.
  80.  
  81. <<INI - Initialization File>>
  82.     ITCOMPAR.INI
  83.     ────────────
  84.  
  85.          Each of the ITs for Clarion utilizes a set of initialization
  86.          files (INIs) for selecting end-user modifiable parameters.
  87.          Each of the pertinent parameters is denoted and discussed
  88.          hereafter.
  89.  
  90. <INI - GRAPHIC=>
  91.      GRAPHIC= 
  92.  
  93.          Each of the ITs for Clarion operates in a text or graphic
  94.          environment.  This INI parameter is essential in the
  95.          operation in graphic mode.  Provided the value of the
  96.          GRAPHIC= parameter is ANY value other than YES {GRAPHIC=YES},
  97.          the utilty defaults to text mode.   Text mode obviously runs
  98.          more quickly than graphic mode; therefore, if speed is of
  99.          utmost importance, then set this value to NO {GRAPHIC=NO}.
  100.  
  101.          If the value is YES {GRAPHIC=YES}, the IT queries the
  102.          computer's video for the current mode.  If the mode is EGA
  103.          or VGA, then the graphic parameters are activated immediately.
  104.          If the video mode is SVGA, then IT sets the video mode to
  105.          VGA then activates the graphic parameter internal to the
  106.          program.
  107.  
  108. <INI - CTLpath=>
  109.      CTLpath= 
  110.  
  111.          Each IT in the ITs for Clarion series utilizes a set of
  112.          control (CTL) files.  These CTL files are used for controlling
  113.          the operation of each of the ITs. Normally, the CTL files are
  114.          placed in the \IT directory; however, they may be moved
  115.          to an alternate directory.  Should you move the CTLs
  116.          to another directory, the value of this parameter must be
  117.          modified to include to new path.
  118.  
  119.          The default is:
  120.                    CTLpath=C:\IT
  121.  
  122.          You might change it to:
  123.                    CTLpath=C:\ITS\CTLS
  124.  
  125. <INI - DemoPath=>
  126.      DemoPath=                                                      │
  127.                                                                           │
  128.       Each IT in the ITs for Clarion has a DEMO. Our efforts              │
  129.       to provide a completely functional DEMO include allowing            │
  130.       the user to establish a customized demo path.                       │
  131.  
  132. <<Files Supplied>>
  133.     Supplied Files
  134.     ──────────────
  135.  
  136.          If you are like us, you want to know what files are supplied
  137.          and what is their purpose.  We hope to provide a listing of
  138.          file extensions used and their purpose in the following
  139.          manner.
  140.  
  141. <Supplied Files>
  142. <├─── EXEs Supplied>
  143.        *.EXE - Executables
  144.  
  145.          Executable files are the program files purchased.  Only EXEs
  146.          required are supplied with the ITs for Clarion series.
  147.  
  148. <├─── DLLs Supplied>
  149.        *.DLL - Dynamic Link Libraries
  150.  
  151.          Dynamic Link Libraries are supplied as necessary to support
  152.          the operation of the ITs for Clarion.  DLLs required
  153.          specifically for its operation are supplied on their unique
  154.          diskette or ZIP file, if accessed via the DTS ***BBS***.
  155.  
  156.          DLLs supplied on a separate diskette are Clarion Database
  157.          Developer (CDD) supporting DLLs for the appropriate batch
  158.          release.  Provided you are running with the same batch as the
  159.          IT was developed, these DLLs are not required.  However, due
  160.          to the fact that some developers may choose to not upgrade
  161.          to the latest release of CDD and that others may upgrade
  162.          to CDD prior to the ITs for Clarion these DLLs are shipped
  163.          to provide compatibility.
  164.  
  165. <├─── HLPs Supplied>
  166.       *.HLP - Help Files                                                  │
  167.                                                                           │
  168.       Help files contains the MANY-MANY linkage for the Help IDs          │
  169.       in the EXE to the help text (TXT) and the help screens.             │
  170.       This file is required to be in the PATH for help to function.       │
  171.                                                                           │
  172. <├─── TXTs Supplied>
  173.       *.TXT - Help Text Files                                             │
  174.                                                                           │
  175.       The Clarion Database Developer help system uses ASCII text          │
  176.       files for the help system.  Unless otherwise noted,                 │
  177.       Diversified Technology Solutions uses a consistant naming           │
  178.       convention for these ASCII text files.  The help text file          │
  179.       inherits the filename of the associated executable with             │
  180.       the TXT extension.  For example, COMPARES.TXT is the ASCII          │
  181.       help file for COMPARES.EXE.                                         │
  182.                                                                           │
  183.       Notice that XTRACEs also contain the TXT extension and are          │
  184.       not required for proper operation of the ITs for Clarion.           │
  185.  
  186. <├─── INIs Supplied>
  187.        *.INI - Initialization Files
  188.  
  189.          Initialization files are supplied with the ITs for Clarion
  190.          series providing end-user control of program parameters.
  191.  
  192. <├─── CTLs Supplied>
  193.        *.CTL - Control Files
  194.  
  195.          Control files are supplied as an integral part of each ITs
  196.          for Clarion module controlling the operations of the utility.
  197.          As new features are included or modified, a simple
  198.          downloading of a new CTL may add addtional features to the
  199.          IT.  All end-user modifiable parameters may be set within
  200.          the specific INI.
  201.  
  202. <└─── $$$s Created>
  203.        *.$$$ - Scratch Files
  204.  
  205.          Scratch files are created by the memory management scheme of
  206.          the TopSpeed DOS extender.  Additionally, the ITs
  207.          for Clarion utilities create scratch files for reporting and
  208.          supporting purposes.  We have opted to use the $$$ extension
  209.          for these files to help you identify those files which may
  210.          be deleted without adverse affects.  Should a system crash
  211.          occur during an ITs process, you may remove any of the
  212.          ITs scratch files without experiencing adverse affects.
  213.          Be careful to not delete any Clarion scratch files while
  214.          CDD is running.
  215.  
  216. <<Main Menu>>
  217.  
  218. IT Compares Main Menu
  219. ═════════════════════
  220.  
  221. <Files>
  222.     Files
  223.     ─────
  224.          The FILES menu option provides a pulldown of two selections:
  225.  
  226.                     Select Files to Compare
  227.                     Exit
  228.  
  229. <Reports>
  230.      Reports
  231.      ───────
  232.          The REPORTS menu option supports the access to reports
  233.          available to the user.  All REPORTS' menu selections are
  234.          dimmed until the SELECT FILES FOR COMPARE under the FILES
  235.          menu has been run in its fruition.  Should the file
  236.          selection optoin be initiated then aborted, the REPORTS
  237.          options are again dimmed.
  238.  
  239.          Three reports are available on the interal data:
  240.  
  241. <├─── Differences in Like Files>
  242.              Differences in Like Files
  243.  
  244.                    Report on the differences in files, keys,
  245.                    indices, fields, groups, and memos on file
  246.                    labels common to both files.
  247.  
  248. <├─── 1st File Labels NOT in 2nd>
  249.              1st File Labels NOT in 2nd
  250.  
  251.                    Report on file components identified in the
  252.                    first file selected not present in the second
  253.                    file selected.
  254.  
  255. <└─── 2nd File Labels NOT in 1st>
  256.              2nd File Labels NOT in 1st
  257.  
  258.                    Report on file components identified in the
  259.                    second file selected not present in the first
  260.                    file selected.
  261.  
  262. <About>
  263.      About
  264.      ─────
  265.          The About menu selection displays a simple screen containing
  266.          general information regarding the product including but not
  267.          limited to the developer and version.
  268.  
  269. <Help>
  270.      Help
  271.      ────
  272.          The Help menu selection retrieves a general help screen with
  273.          additional information pertaining to this IT.
  274.  
  275. <<Select Files for Comparison>>
  276.    Select Files for Comparison
  277.    ═══════════════════════════
  278.  
  279.          The user selects two valid Clarion PROGRAM files for
  280.          comparison of the FILE definitions.  As each file is
  281.          selected it is checked to be a valid Clarion PROGRAM
  282.          file.  If not, the process is aborted and control is
  283.          returned to the file selection screen.
  284.  
  285. <File Selection>
  286.      File Selection
  287.      ──────────────
  288.  
  289.          A standard set of screen fields are available in the file
  290.          selection screen.  Each is described below.
  291.  
  292. <├─── File Mask>
  293.       File Mask 
  294.  
  295.          The File Mask field permits the input of a filter on the
  296.          file names available in the Files list box.  The default
  297.          File mask is set to *.CLA to limit the display of Files
  298.          list box to a set of files containing the default Clarion
  299.          extension.
  300.  
  301. <├─── Directory >
  302.       Directory 
  303.  
  304.          The Directory field displays the currently selected
  305.          directory.  As the path changes due to pertinent
  306.          selections from the Directories field, the currently
  307.          selected directory is displayed in this field.
  308.  
  309. <├─── Files>
  310.       Files 
  311.  
  312.          The Files field provides a listing of files available from
  313.          within the selected directory.  The Files list box is
  314.          filtered by the entry in the File Mask field.  The desired
  315.          file may be selected by cursor or mouse movement placing the
  316.          cursor bar on the desired entry followed by selection
  317.          of the OK button OR simply double-clicking the left mouse
  318.          button on the desired file.
  319.  
  320. <├─── Directories>
  321.       Directories 
  322.  
  323.          The Directories field provides a listing of directories.
  324.          The desired directory may be selected by cursor or mouse
  325.          movement placing the cursor bar on the desired entry
  326.          followed by selection of the OK button OR simply double-
  327.          clicking the left mouse button on the desired directory.
  328.  
  329. <├─── OK>
  330.       OK 
  331.  
  332.          Selecting the OK button completes the selection of file.
  333.          Once the file is selected, its contents are immediately
  334.          validated to be a Clarion PROGRAM file.
  335.  
  336. <└─── Cancel>
  337.       Cancel 
  338.  
  339.          Selecting the CANCEL button aborts the file selection
  340.          process and returns control to the main menu.
  341.  
  342. <File Processing>
  343.     Processing the Selected Files
  344.     ─────────────────────────────
  345.  
  346.          After each of the files have been selected and validated
  347.          for containing the appropriate scope, the contents of
  348.          each file are parsed into an internal supporting data set.
  349.          Once the data is available in a database format the
  350.          information is much more easily processed.
  351.  
  352.          As each file is processed an appropriately titled list
  353.          box is displayed with the contents displayed as parsing
  354.          occurs.  As each source file is parsed, INCLUDE files
  355.          located within the GLOBAL scope are added to the parsing
  356.          stack to support their parsing to ensure all FILE definitions
  357.          are indentified indeed.
  358.  
  359. <└─── Special NOTE on INCLUDEs>
  360.        NOTE: Any of the INCLUDE files MUST be explicitly denoted
  361.              inclusive of the path. If the complete path is NOT
  362.              specified within the INCLUDE file name, only the default
  363.              directory is searched.  Neither the PATH nor RED are
  364.              used to locate INCLUDE files.
  365.  
  366.          A field on the parsing screen immediately above the list
  367.          box displays the file currently parsed.
  368.  
  369. <Exit>
  370.    Exit
  371.    ────
  372.          Selecting EXIT from the FILE menu performs minor clean-up
  373.          functions prior to returning control to the DOS environment.
  374.          All temporary files created by IT Compares are deleted from
  375.          the disk and the default directory is set to that from
  376.          which the program was initiated.
  377.  
  378. <<Report Redirection>>
  379.     Redirecting Report Output
  380.     ═════════════════════════
  381.  
  382.          After selecting a report for analysis, the standard CDD
  383.          template redirection screen is provided for directing the
  384.          report output to the desired device.
  385.  
  386. <Report Destination>
  387. <├─── Destination>
  388.      Destination 
  389.  
  390.          A radio button selection is provided for redirection of
  391.          the report output.  Devices are available as follows.
  392.  
  393.                    Parallel Ports
  394.                              LPT1, LPT2, LPT3, and LPT4
  395.  
  396.                    Serial Ports
  397.                              COM1, COM2, COM3, and COM4
  398.  
  399.                    Disk File
  400.                              FILE
  401.  
  402.                    Screen Display
  403.                              SCREEN
  404.  
  405. <├─── Filename>
  406.      Filename 
  407.  
  408.          If the FILE radio button is selected as the Destination
  409.          field, control is passed to the Filename field prompting
  410.          for the input of a disk file name.
  411.  
  412. <├─── OK>
  413.      OK 
  414.  
  415.          Selecting the OK button initiates the report generation with
  416.          output directed to the opted device.
  417.  
  418. <└─── Cancel>
  419.      Cancel 
  420.  
  421.          Selecting the CANCEL button aborts the report generation
  422.          and control is returned to the menu.
  423.  
  424. <<View Report>>
  425. <Report Viewing>
  426.   View Report Output
  427.   ══════════════════
  428.  
  429.          After selecting a report for analysis, the standard CDD
  430.          template redirection screen is provided for directing the
  431.          report output to the desired device.
  432.  
  433.          If the SCREEN or FILE is selected as the output device,
  434.          a list box is displayed permitting the viewing of the
  435.          report on screen.  Three buttons are supplied: Print, Exit,      │
  436.          and Help.                                                        │
  437.  
  438. <├─── Print>
  439.      Print 
  440.  
  441.          The output displayed on the screen may be printed by
  442.          pressing the Print button.  Once PRINT is selected a set
  443.          of radio buttons is displayed beneath the list box for
  444.          selecting the device for output.  Devices available are:
  445.  
  446.                     LPT1, LPT2, LPT3, LPT4, and
  447.                     COM1, COM2.
  448.  
  449. <├─── Exit>
  450.      Exit 
  451.  
  452.          Exits the viewing port and returns control to the main menu.
  453.  
  454. <  └─── Help>
  455.        Help                                                         │
  456.                                                                           │
  457.       Help relevant to this process is available by selecting             │
  458.       this button.                                                        │
  459.